dxp-ux
customerBillById(TMF678 GET) retriveCustomerBill By ID - V2
CASE 1 Unitary Test
This usecase is to retrieve bill history from evertec
URL
https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v2/PR/customerBill/1223334444URI Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
| id | string | bill document unique identifier | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| billingAccount.id | string | customer account id | Y* |
| billDate | string | bill date of the account | Y* |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | Y |
Request
curl --location 'https://nonprod.esb.cloud.lla.com/test/dxp-ux/dxp-ux/v2/PR/customerBill/252929057?billingAccount.id=821470133&billDate=2024-01-10' \
--header 'client_id: xxx' \
--header 'client_secret: yyy' \
--header 'X-Correlation-ID: 25-8412-9621-85415'Response
200 OK
[
{
"billDate": "2024-01-10", //billDate
"billDocument": [
{
"id": "252929057", //objectId
"url": "https://evertec.com/pdf/url" //objectUrl
}
],
"billingAccount": {
"id": "821470133" //billingAccount.id
}
}
]Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| billDate | datetime | Bill date | N |
| billDocument | array | Array object of bill document | N |
| billDocument.id | string | bill document object unique identifier | N |
| billDocument.url | string | url of the bill downloadable bill document | N |
| billingAccount | object | billing account object | N |
| billingAccount.id | string | unique identifier of billingAccount | N |